Prepare release #166
Merged
Prepare release #166
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Add options for proof directive title formatting Introduces new configuration options: proof_title_format, proof_number_weight, and proof_title_weight, allowing users to customize the format and font weight of proof directive titles. Documentation and CSS updated to reflect these changes, and directive logic now applies the user-defined title format.
* feat: Added possibility for shared numbering of theorems, fixing issue #64 (#161) Added optioin to have directives share numbering. Reflected also in docs. * Add config validation Introduces a check_config_values function to validate Sphinx configuration values at runtime, ensuring correct types and defaults for proof-related settings. --------- Co-authored-by: Leonid Ryvkin <ryvkin@gmx.com>
Introduced CSS variables and styles for 'notation' admonitions in both minimal and main proof.css. Standardized and expanded the use of CSS custom properties for all proof-related admonition types, improving maintainability and visual consistency.
Introduces a new section describing the `prf:notation` directive, its options, usage examples, and referencing notations in the documentation.
Included the [notation](syntax:notation) directive in the list of supported directives on the documentation index page.
Added details about shared numbering for directive groups, fixed CSS inconsistencies, and documented the notation directive in CHANGELOG.md. Updated README.md to include the notation directive, mention shared numbering, and clarify styling options.
Appended a newline character to the end of sphinx_proof/_static/proof.css to follow POSIX file standards and improve compatibility with some tools.
Improves handling of nested unenumerable nodes by correctly identifying the appropriate occurrence of '<p class="admonition-title">' in the body. Updates the list_rindex function to support skipping occurrences, addressing issue #165.
Adds IDs to title nodes when the 'nonumber' option is set, enabling more reliable identification of titles in HTML output. Refactors the depart_unenumerable_node function to use these IDs for inserting captions, simplifying the logic and improving robustness.
Updated the algorithm admonition title to include a 'caption-number' span and set the id attribute for improved structure and accessibility.
Tom-van-Woudenberg
approved these changes
Jan 27, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces several new configuration options and improvements to the Sphinx-Proof extension, focusing on enhanced customization for directive titles, support for shared numbering between directive types, and the addition of a new "notation" directive. It also improves documentation and CSS styling for consistency and flexibility.
New Features and Configuration Options:
proof_title_formatoption, as well asproof_number_weightandproof_title_weightfor CSS font-weight customization. These options can be set in both Sphinx and Jupyter Book projects. (Fd2c6942L27R144, [1] [2] [3] [4]prf_realtyp_to_countertypoption to allow shared numbering across groups of directives, enabling more flexible counter management. (Fd2c6942L27R144, [1] [2] [3] [4]Documentation Updates:
Styling and CSS Improvements:
--obseration-border-colorto--observation-border-color). [1] [2] [3]Internal Improvements:
These changes provide users with greater flexibility in formatting and organizing mathematical directives, improved documentation, and more consistent styling across directive types.
This PR: